home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 081 / oops.arc / OOPS.DOC next >
Text File  |  1987-08-20  |  14KB  |  367 lines
  1.  
  2. -----------------------------------------------------------------------
  3. Program: Oops
  4.   Title: Opus Outbound Parcel Sniffer - Loose Notes
  5. Version: 0.36
  6. Release: 19 Aug 1987
  7.  Author: Tom Kashuba, PComm, FidoNet 167/1, (Crash Accepted)
  8.  
  9. -----------------------------------------------------------------------
  10. What's new with this version:
  11.  
  12.        ____________________
  13.    ___/ 0.36 ... 19-Aug-87 \___
  14.  
  15.    This is the first GENERAL RELEASE version of Oops.  It is not
  16.    intended to be a full implmentation of Oops' stated design goals
  17.    but, rather, a reasonably stable foundation upon which to mature.
  18.  
  19.    There is no documentation available at the time of this release
  20.    due to my impending flight to the 4th National Sysop Convention
  21.    where this release will first make its debut.
  22.  
  23.    Sometime thereafter, some form of documentation will be made
  24.    available as a separate file and, then, as part of the Oops
  25.    distribution kit.
  26.  
  27.    o User File Manager changes ...
  28.  
  29.      - Fixed decimal rounding & display of User CR/DB fields.
  30.      - Changed upload "rate" calc to (UL-DL)/(CALLS+1)
  31.      - Removed Sysop from screen titles for longer SysNames
  32.      - Increased menu size to 3 lines (from 2 )
  33.      - Added C)lear command to reset Time & DL limits ONLY!
  34.      - Removed unnecessary screen repaint in cancelled Zap
  35.      - Fixed record not being displayed after a J)ump
  36.  
  37.    (Refer to the section "Revision History" for all past changes)
  38.  
  39.  
  40. -----------------------------------------------------------------------
  41. Description:
  42.  
  43.    The design intent of 'Oops' is to become a generalized Opus
  44.    environmental editor.  A number of general features have been
  45.    incorporated to make life a little easier, such as:
  46.  
  47.       o Uses the Opus ".prm" file to pickup all basic environmental data.
  48.       o Uses either BIOS video or generic ANSI (future remote use).
  49.       o Sets outbound path from Opus .PRM  file or by command line.
  50.       o Has a remote mode wherein Oops terminates on loss of CARRIER.
  51.       o Sets system Address, Sysop, and Name from Opus .PRM file.
  52.  
  53.    In its initial releases, it concentrates on facilities to manipulate
  54.    the Opus outbound "holding" area.  Its key functions are:
  55.  
  56.       o User Files Maintenance Function
  57.  
  58.       o System Area Maintenance Function
  59.  
  60.       o Outbound Mail Maintenance Function
  61.  
  62.         - Initiates Naked POLLs via Null FidoNet Packets ("Bundles")
  63.         - Initiates Quick File Requests (creates NULL bundles if needed)
  64.         - Initiates Quick File Sends    (creates .?LO file)
  65.         - Lists all pertinent mail type object in the hold area.
  66.         - Optionally display the files within ATTACH'd lists.
  67.         - Optionally display empty, zero-length ARCmail entries.
  68.         - Expand funtion: Lists From/To/Subj of messages within bundles.
  69.         - Erase function: Delete mail objects.
  70.         - Address function: Changes dest address of mail objects.
  71.         - Handling function: Changes object handling (Norm,Direct,Hold,etc)
  72.         - Raw Directory: Lists ANY files in outbound (or other) dir's.
  73.         - Merges bundles when necessary due to address changes.
  74.         - Merges file lists when necessary due to address changes.
  75.  
  76.    As the basic Opus structures have already been incorporated, future
  77.    versions of Oops are planned to have:
  78.  
  79.       o System integrity verification.
  80.       o Opus .PRM file editor - could eliminate manual .CTL editing.
  81.       o Anything else I can think of or is suggested - hint!
  82.       o Possible bundler/unbundler - We'll see.
  83.  
  84. -----------------------------------------------------------------------
  85. Operation:
  86.  
  87.    Oops takes all its necessary operational information from a given
  88.    .PRM file name via the "(name)" command line option or via a "OOPS="
  89.    in the environment.  This option can simply specify the root name
  90.    of the .PRM file or can also include a prepended path to use a parm
  91.    file in another directory.  No extension is allowed.
  92.  
  93.    Ex: Oops opus .......... use Opus.Ctl in current directory
  94.    Ex: Oops \abc\myparm ... use MyParm.Ctl in directory "\abc"
  95.  
  96.    For testing purposes, you can also separately specify the outbound
  97.    mail path so as to override the outbound path found in the given
  98.    Opus parm file.  This allows you to create a separate work area in
  99.    which to shake down Oops without fear of destroying your real mail
  100.    hold area.
  101.  
  102.    Ex: Oops opus -o\work .. use Opus.Ctl, force Outbound path "\work"
  103.  
  104.    When Oops begins execution, it will show you the default parameters,
  105.    pause for anykey, and will then bring you to the Main Function Menu.
  106.  
  107.    User File Maintenance ...
  108.  
  109.       This function is straight forward.  Much like most User File
  110.       editors.  It has an interesting "Find Suspect Records" command
  111.       and a user lister with text search on name and location fields.
  112.  
  113.    System Area Maintenance ...
  114.  
  115.       This function allows you to display, editor, create, or delete
  116.       Opus System Areas including the Root System (System.Bbs).
  117.  
  118.    Outbound Function ...
  119.  
  120.       This function is the "raison d'etre" for for Oops.  When selected,
  121.       the screen clears and Oops "sniffs" the outbound area for mail
  122.       type objects such as File and Request lists, Bundles, and Arc's.
  123.  
  124.       A screen will then be presented, vaguely similar to Lotus, listing
  125.       all the mail objects found.  ATTACH lists are not expanded nor are
  126.       zero length ARCmail items listed.  The "#" and "0" options reverse
  127.       those defaults.
  128.  
  129.       General operation is conducted by pressing a function's key.  If
  130.       the function modifies an object, you are then prompted for the
  131.       entry number of the object.  If the desired operation is allowed
  132.       on that object, operation continues.
  133.  
  134.       A limited help screen will be shown with the "?" key.
  135.  
  136. -----------------------------------------------------------------------
  137. Quick Start Guide ...
  138.  
  139. If your Opus root dir is "C:\OPUS" and your Opus parm file's name is
  140. Opus.Prm, then the following will get you going real quick ...
  141.  
  142. 1. Place Oops.Exe in Opus Root
  143. 2. Issue the DOS command "SET OOPS=c:\Opus\Opus"
  144. 3. Run "Oops"
  145.  
  146. If you want to test run on a separate outbound test area, then use the
  147. "-o(path)" command to override the outbound path found in the .PRM file.
  148.  
  149. Run: "Oops -oC:\TEST"      (Assuming steps 1-3, above)
  150.  
  151. You can forgo the environmental SET option and just enter the Opus parm
  152. file name on the command line without any prefix ...
  153.  
  154. Run: "Oops Opus -oC:\TEST"  .. Use Opus.Prm (curr dir), C:\TEST outbound
  155. Run: "Oops Opus             .. Use Opus.Prm (curr dir), normal outbound
  156.  
  157.  
  158. The command line option of "-h" will show the command line switches.
  159.  
  160.  
  161. -----------------------------------------------------------------------
  162. PREVIOUS Revision History ...
  163.  
  164. In lieu of any formal documentation for Oops, use this revision history
  165. as a form of on-going features list.
  166.  
  167.        _____________________
  168.    ___/ 0.35a ... 17-Aug-87 \___
  169.  
  170.    o User
  171.  
  172.      - Moved "Jump to Area" prompt to standard message position
  173.      - Fixed certain user field updates not setting UPDATE flag
  174.      - Fixed User List age call & display
  175.      - Added "Benefit Ratio" {UL*UL/(DL+1)} to Sort & List
  176.      - Fixed Menu and Privilege prompt typos
  177.      - Added M)ark and P)ack to Menu
  178.  
  179.    o Area
  180.  
  181.      - BBS Path: Allow spec w/o trailing '\'.  Prompts, if none.
  182.  
  183.    o Outbound
  184.  
  185.      - SendFile: Added prompt to allow files that aren't found.
  186.  
  187.        _____________________
  188.    ___/ 0.34a ... 15-Aug-87 \___
  189.  
  190.    Quick maintenance release to increase stack from 2k to current 4k.
  191.    V0.33a's 2k stack may cause problems in some environments.  Please
  192.    replace v0.33a as soon as possible.
  193.  
  194.        _____________________
  195.    ___/ 0.33a ... 12-Aug-87 \___
  196.  
  197.    o Area Manager
  198.  
  199.      - Fix path input routine so that any missing '\' is appended.
  200.      - Added "* CHANGED *" screen indicator to show pending changes.
  201.  
  202.    o Outbound Manager
  203.  
  204.      - Tweaked Screen Colors minorly
  205.  
  206.        _____________________
  207.    ___/ 0.32a ... 03-Aug-87 \___
  208.  
  209.    o Overall
  210.  
  211.      - Added Execute option to skip Menu (eg, -xa to jump into Area Mgr)
  212.      - Internal fixes (Global Pgm Ver, Name, Tit)
  213.      - Allow ",.=" to mean "<>+"  {Doug Boone}
  214.      - Cleaned up some memory management problems
  215.      - ... and many ideas nefariously linked to Bob Davis
  216.  
  217.    o Outbound
  218.  
  219.      - Added Naked POLL via Null, 60 byte F-Net packet
  220.      - Zero Arc option now only effective when Files option ON.
  221.      - Fixed bug that ignored Zero Arc's  {Rick Moore}
  222.      - Added "POLL" object title for 60 byte "poll" bundles
  223.  
  224.    o Area Maintenance
  225.  
  226.      - The +- and <> meanings have reversed (+- ActArea, <> PhysArea)
  227.      - Home/"B"/"1" are all equivalent meaning Beginning Area
  228.      -  End/"E"/"0" are all equivalent meaning Ending Area
  229.      - Added R)estore area (from disk) option
  230.      - Default area data now partially based on System.Bbs record
  231.      - Changed Priv setting to menu select, not rotates
  232.      - Added W)rite (save area) option
  233.  
  234.    o User Maintenance
  235.  
  236.      - Home/"B"/"1" are all equivalent meaning Beginning Record
  237.      -  End/"E"/"0" are all equivalent meaning Ending Record
  238.      - Added R)estore user data (from disk) option
  239.      - Added multi-field user sort with 1st record freeze option.
  240.      - Eliminated need for "E" Edit Prefix in editing fields.
  241.      - Added W)rite (save rec) Option
  242.      - Added confirmation prompt to APPEND Record Option
  243.      - Added Update Check / SAVE check upon possible record change
  244.      - Added "Marked Records" to User List function options
  245.      - Cleaned up the code a bit
  246.      - Changed Priv and Help to menu select, not rotates.
  247.      - Reduced unneeded screen regens
  248.  
  249.        ______________________
  250.    ___/ 0.31a ... 01-Aug-87  \___
  251.  
  252.    o Overall
  253.  
  254.      - Removed CodeView hooks ( 192k -> 100k )
  255.  
  256.    o Area Maintenance
  257.  
  258.      - Fixed NORMAL priv problem (blush)  {Rick Moore}
  259.      - Increased Call Count i/o max to 9,999,999
  260.      - Fixed problem w/Update Sensing upon ">" or "<"
  261.      - Added clear of Msg & File Area Titles with a <CR>
  262.      - Added clear of Msg, DnLd, & UpLd Path's with a <CR>
  263.  
  264.    o Outbound
  265.  
  266.      - Added ditto's (") for multiple object address display
  267.      - Added full handling of Orphan Call trigger files.
  268.      - Optimized display code a little
  269.      - Fixed bug that displayed all new attaches as HOLD
  270.  
  271.    o User Maintenance
  272.  
  273.      - Improved PRIV handling (no problem, just cleaner)
  274.  
  275.        _____________________
  276.    ___/ 0.30a ... 30-Jul-87 \___
  277.  
  278.    o Added SYSTEM AREA MAINTENANCE !!!
  279.    o Converted to LARGE model (Ugh, Grrrr, Rocks to BelleVue)
  280.    o Added User List function to User Maintenance
  281.    o Corrected problem with display ordering of newly added objects
  282.    o Compiler Error! Compiler Error! Compiler Error! Compiler Error!
  283.  
  284.        _____________________
  285.    ___/ 0.28a ... 26-Jul-87 \___
  286.  
  287.    o Added USER FILE MAINTENANCE !!!
  288.  
  289.    o Changed REQ file tagging method from .?LO file to NULL Bundle
  290.    o Added NodeList look-up to REQ file function
  291.    o Added User File Path pickup from Opus .PRM file
  292.    o Fixed FATAL Memory Allocation Bug
  293.    o Added .REQ object type for display & requesting
  294.    o Added Quick File Request (WaZoo protocol only)
  295.    o Fixed eXpand packet to handle Aberrant Dates (finally)
  296.    o Added initial, front end menu for other future functions
  297.    o Added environment variable "OOPS=(Parm File Path)"
  298.    o Added .PKT object type for display & future re-bundling
  299.    o Added prompt for Handling to Send and Request File option
  300.    o Shrunk data area by one line to increase menu size
  301.    o Changed Display's R)egen -> !)Regen
  302.    o Added a little color to help display
  303.    o Changed outbound preload "sniffing" display
  304.  
  305. 0.27a ... 17-Jul-87
  306.  
  307.    o Added handling of DFO and NOT object types
  308.    o Fixed Over-Scroll in Expand-Packet display
  309.    o Touched up screen display positioning
  310.    o Altered coloring philosophy (hat to Jan Vandenbos)
  311.  
  312. 0.26a ... 16-Jul-87
  313.  
  314.    o Added CONFIRM to erase function
  315.    o Added -C and -C0 switches to force color ON or OFF, respectively
  316.    o Fixed the Packet Merge (I think)
  317.    o Sped up the screen painting as much as BIOS would allow.
  318.    o Added the much needed confirmation to the Erase (DELETE) function.
  319.    o Added a little more consistency to the screen annotations
  320.    o Changed several option letters for more 1-key actions
  321.    o I cleaned up the color settings
  322.  
  323. 0.25a ... 15-Jul-87
  324.  
  325.    o Added merge of Bundles and File Lists
  326.    o Added packet expansion
  327.    o Added directory display
  328.    o Added Failed Call handling
  329.  
  330. 0.20a ... 13-Jul-87
  331.  
  332.    o Added Quick File Send
  333.  
  334. 0.10a ... 10-Jul-87
  335.  
  336.    o First test release, mail object display only
  337.  
  338.  
  339. -----------------------------------------------------------------------
  340. 11th Hour User Notes:
  341.  
  342. - v0.36 uses overlays to better use memory for those of you running
  343.   with limited memory or in a multitasked environment.
  344.  
  345. - In multitasked environments, should you be in outbound and your
  346.   other partition is altering the outnound state, you should occasionally
  347.   do a quick "QO" command to QUIT outbound and immediately re-enter it.
  348.   This will cause a re-scan if the outbound area.  ReGen just repaints
  349.   the screen to clear up any line-noise screen garbage.
  350.  
  351. - Whenever a merge of file attach lists is triggered by such things
  352.   as address or handling changes, there is no check on duplicates.
  353.   The resulting file list will then contain the exact sum of the
  354.   original two file lists, one after the other.  For the time being
  355.   if you see that happen, you can correct the "xxxxxxxx.?LO" file
  356.   with your text editor.  Yeah, I know.  It shouldn't happen very
  357.   often, though, as one seldom has different ATTACH lists to the
  358.   same node but with different handling.
  359.  
  360. - All major Outbound functions have *NOT* been tested with very large
  361.   outbound areas.
  362.  
  363. -----------------------------------------------------------------------
  364.  
  365. =Kash=
  366.  
  367.